\hypertarget{class_activatable_filter}{\section{Activatable\-Filter$<$ Value $>$ Class Template Reference}
\label{class_activatable_filter}\index{Activatable\-Filter$<$ Value $>$@{Activatable\-Filter$<$ Value $>$}}
}


{\ttfamily \#include $<$Activatable\-Filter.\-hpp$>$}

Inheritance diagram for Activatable\-Filter$<$ Value $>$\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{class_activatable_filter}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_activatable_filter_af35171414d4508b2939e265bf10c4752}{Activatable\-Filter} (boost\-::shared\-\_\-ptr$<$ const \hyperlink{class_filter}{Filter}$<$ Value $>$ $>$ filter)
\item 
\hyperlink{class_activatable_filter_a9f8c6d70281dd3cb4f80c11b06468e9d}{Activatable\-Filter} (const \hyperlink{class_filter}{Filter}$<$ Value $>$ $\ast$filter, bool can\-Delete\-Filter=false)
\item 
void \hyperlink{class_activatable_filter_a75d7e7529f39c3d2244ffb42b0d4dbd8}{Set\-Is\-Active} (bool is\-Active)
\item 
virtual Value \hyperlink{class_activatable_filter_a631243667c97dd9a676bfb55e5f2c0e4}{Apply} (const Value \&input) const 
\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename Value$>$class Activatable\-Filter$<$ Value $>$}

The \hyperlink{class_activatable_filter}{Activatable\-Filter} template class that wraps another \hyperlink{class_filter}{Filter} and applies the inner \hyperlink{class_filter}{Filter} only if the \hyperlink{class_activatable_filter}{Activatable\-Filter} is activated.


\begin{DoxyTemplParams}{Template Parameters}
{\em Value} & The type of the input and output object. \\
\hline
\end{DoxyTemplParams}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_activatable_filter_af35171414d4508b2939e265bf10c4752}{\index{Activatable\-Filter@{Activatable\-Filter}!Activatable\-Filter@{Activatable\-Filter}}
\index{Activatable\-Filter@{Activatable\-Filter}!ActivatableFilter@{Activatable\-Filter}}
\subsubsection[{Activatable\-Filter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Value $>$ {\bf Activatable\-Filter}$<$ Value $>$\-::{\bf Activatable\-Filter} (
\begin{DoxyParamCaption}
\item[{boost\-::shared\-\_\-ptr$<$ const {\bf Filter}$<$ Value $>$ $>$}]{filter}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{class_activatable_filter_af35171414d4508b2939e265bf10c4752}
Constructor for \hyperlink{class_activatable_filter}{Activatable\-Filter}.


\begin{DoxyParams}{Parameters}
{\em filter} & A shared pointer to the filter to be wrapped. \\
\hline
\end{DoxyParams}
\hypertarget{class_activatable_filter_a9f8c6d70281dd3cb4f80c11b06468e9d}{\index{Activatable\-Filter@{Activatable\-Filter}!Activatable\-Filter@{Activatable\-Filter}}
\index{Activatable\-Filter@{Activatable\-Filter}!ActivatableFilter@{Activatable\-Filter}}
\subsubsection[{Activatable\-Filter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Value $>$ {\bf Activatable\-Filter}$<$ Value $>$\-::{\bf Activatable\-Filter} (
\begin{DoxyParamCaption}
\item[{const {\bf Filter}$<$ Value $>$ $\ast$}]{filter, }
\item[{bool}]{can\-Delete\-Filter = {\ttfamily false}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{class_activatable_filter_a9f8c6d70281dd3cb4f80c11b06468e9d}
Constructor for \hyperlink{class_activatable_filter}{Activatable\-Filter}.


\begin{DoxyParams}{Parameters}
{\em filter} & A pointer to the filter to be wrapped. \\
\hline
{\em can\-Delete\-Filter} & If the \hyperlink{class_activatable_filter}{Activatable\-Filter} can delete the \hyperlink{class_filter}{Filter} so long as it functions correctly. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{class_activatable_filter_a631243667c97dd9a676bfb55e5f2c0e4}{\index{Activatable\-Filter@{Activatable\-Filter}!Apply@{Apply}}
\index{Apply@{Apply}!ActivatableFilter@{Activatable\-Filter}}
\subsubsection[{Apply}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Value $>$ virtual Value {\bf Activatable\-Filter}$<$ Value $>$\-::Apply (
\begin{DoxyParamCaption}
\item[{const Value \&}]{input}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{class_activatable_filter_a631243667c97dd9a676bfb55e5f2c0e4}
Apply the filter to an input.

If the filter is active, the inner filter will be applied. If the filter is not active, a copy of the input will be output.


\begin{DoxyParams}{Parameters}
{\em input} & A reference to the input (which will not get modified). \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The output of the filtered input. 
\end{DoxyReturn}


Implements \hyperlink{class_filter_a377c1d2a9400698fdf5a41d293fd32b8}{Filter$<$ Value $>$}.

\hypertarget{class_activatable_filter_a75d7e7529f39c3d2244ffb42b0d4dbd8}{\index{Activatable\-Filter@{Activatable\-Filter}!Set\-Is\-Active@{Set\-Is\-Active}}
\index{Set\-Is\-Active@{Set\-Is\-Active}!ActivatableFilter@{Activatable\-Filter}}
\subsubsection[{Set\-Is\-Active}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Value $>$ void {\bf Activatable\-Filter}$<$ Value $>$\-::Set\-Is\-Active (
\begin{DoxyParamCaption}
\item[{bool}]{is\-Active}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{class_activatable_filter_a75d7e7529f39c3d2244ffb42b0d4dbd8}
Activate or deactivate the filter.


\begin{DoxyParams}{Parameters}
{\em is\-Active} & Whether to set the filter to be active. \\
\hline
\end{DoxyParams}


The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
C\-:/\-Users/\-Sam/\-Projects/\-F\-R\-C/\-Libraries/\-Fpk/\-Entech-\/\-Fpk-\/\-Subscribers/\-Entech-\/\-Fpk/\-Filters/Activatable\-Filter.\-hpp\end{DoxyCompactItemize}
